Reporting-CachingSettings

[GET] /api/v2/reporting/caching-settings/{reportId}

获取报表的缓存设置。

参数:

名称	类型	位置	描述
reportId必填项	string	path	报表编号。例如：998118f9-40b2-4d28-87b3-ac0bf51397f9

返回值

状态码: 200

成功

CachingSettingsResponse

状态码: 400

错误的请求

ReportingPluginError

状态码: 403

禁止

ReportingPluginError

状态码: 404

未找到

ReportingPluginError

[PUT] /api/v2/reporting/caching-settings/{reportId}

设置报表的缓存设置。

参数:

名称	类型	位置	描述
reportId必填项	string	path	报表编号。例如：998118f9-40b2-4d28-87b3-ac0bf51397f9

请求数据格式

CachingSettingsUpdateRequest

返回值

状态码: 204

无内容

状态码: 400

错误的请求

ReportingPluginError

状态码: 403

禁止

ReportingPluginError

状态码: 404

未找到

ReportingPluginError

类型定义

Ƭ CachingSettingsResponse

缓存设置响应模型。

名称	类型	描述
reportCacheEnabled	Boolean	已为报表启用缓存。
value	int32	缓存间隔值。
interval	CachingInterval
type	CachingType
allowUserToChangeExpiry	Boolean	允许用户更改缓存间隔和值。
allowUserToChangeType	Boolean	允许用户更改缓存类型。
cacheEnabled	Boolean	系统缓存已启用。

Ƭ CachingInterval

Enum:

Hour
Day
Week
Month

枚举可能的缓存间隔。

* hour - 0 - 小时
* day - 1 - 天
* week - 2 - 周
* month - 3 - 月份

Ƭ CachingType

Enum:

Preview
Full

可能的缓存类型的枚举。

* preview - 0 - 预览
* full - 1 - 完整

Ƭ ReportingPluginError

报表插件错误

名称	类型	描述
code可为空	string	错误代码
message可为空	string	错误信息
context可为空	string	错误上下文

Ƭ CachingSettingsUpdateRequest

缓存设置请求模型。

名称	类型	描述	示例
reportCacheEnabled	Boolean	启用或禁用报表缓存。	`true`
value	int32	缓存间隔值。	`1`
interval	CachingInterval
type	CachingType